<?php
///////////////////////////////////////////////////////////////////////////////////////////////////////
//  这个文件是 JCAT PHP框架的一部，该项目和此文件 均遵循 GNU 自由软件协议
// 
//  Copyleft 2008 JeCat.cn(http://team.JeCat.cn)
//
//
//  JCAT PHP框架 的正式全名是：Jellicle Cat PHP Framework。
//  “Jellicle Cat”出自 Andrew Lloyd Webber的音乐剧《猫》（《Prologue:Jellicle Songs for Jellicle Cats》）。
//  JCAT 是一个开源项目，它像音乐剧中的猫一样自由，你可以毫无顾忌地使用JCAT PHP框架。JCAT 由中国团队开发维护。
//  正在使用的这个版本是：0.5.0 / SVN信息: $Id: class.JCAT_DBAdjacensyCategoryTree.php 1603 2009-03-31 15:35:42Z alee $
//
//
//
//  相关的链接：
//    [主页] http://jcat.JeCat.cn
//    [下载(HTTP)] http://code.google.com/p/jcat-php/downloads/list
//    [下载(svn)] svn checkout http://jcat-php.googlecode.com/svn/branches/0.4.0/Framework/ JCAT0.4
//    [在线文档] http://jcat.JeCat.cn/document
//    [社区] http://jj.jecat.cn/forum-7-1.html
//  不很相关：
//    [MP3] http://www.google.com/search?q=jellicle+songs+for+jellicle+cats+Andrew+Lloyd+Webber
//    [VCD/DVD] http://www.google.com/search?q=CAT+Andrew+Lloyd+Webber+video
//
///////////////////////////////////////////////////////////////////////////////////////////////////////
/*-- Project Introduce --*/
namespace JCAT ;


/**
 * What's this Class ?
 *
 * @author		alee
 * @access		public
 */
class DBAdjacensyCategoryTree extends DBAggregationModel
{
	/**
	 * 构造函数
	 *
	 * @access	public
	 * @return	void
	 */
	public function DBAdjacensyCategoryTree( ORM $aORM )
	{
		if( $aORM->GetFieldByProperty(DBAdjacensyCategory::BORDER_LEFT)===null 
				or $aORM->GetFieldByProperty(DBAdjacensyCategory::BORDER_RIGHT)===null )
		{
		 	throw new Exception(Language::SentenceEx(
		 		'传递给 邻接分类模型(DBAdjacensyCategory)的 ORM对象缺少必须的属性/字段映射（%s,%s）'
		 		, 'JCAT', null ,DBAdjacensyCategory::BORDER_LEFT, DBAdjacensyCategory::BORDER_RIGHT
		 	)) ;
		}
		
		$this->DBAggregationModel($aORM) ;
		$this->SetPrototype('DBAdjacensyCategory') ;
	}
	
	/**
	 * Description
	 *
	 * @access	public
	 * @param	$Prototype		null,string,DBAdjacensyCategory
	 * @return	void
	 */
	public function SetPrototype($Prototype)
	{
		ASSERT::ASSERT_ISTHESE( $Prototype, array('null','JCAT\DBAdjacensyCategory')
					, Language::SentenceEx('参数 $Prototype 必须是一个 DBAdjacensyCategory 派生类或实例。','JCAT',null) );

		parent::SetPrototype($Prototype) ;
	}
	
	/**
	 * Description
	 *
	 * @access	public
	 * @param 	$bBuildTree=true
	 * @return	bool
	 */
	public function Load($bBuildTree=true)
	{
		// delete root of tree
		$this->aVirtualRootCategory = null ;
		
		if( !parent::Load() )
		{
			return false ; 
		}
		
		// rebuild the tree
		if($bBuildTree)
		{
			$this->BuildTree() ; 
		}
		
		return true ;
	}
	
	/**
	 * What's this Method ?
	 * 
	 * @access	public
	 * @param	$aModel		DBAdjacensyCategory
	 * @return	void
	 */
	public function AddModel( IModel $aModel, $sName=null )
	{
		ASSERT::ASSERT_INSTANCE($aModel,'JCAT\DBAdjacensyCategory'
			, Language::SentenceEx('参数 $aModel 必须为一个DBAdjacensyCategory实例','JCAT',null));

		return parent::AddModel($aModel,$aModel->GetLeftBorder()) ;
	}
	
	
	/**
	 * Description
	 *
	 * @access	public
	 * @param	$aRecordSet			DBRecordSet
	 * @param	$aORM				ORM
	 * @param	$aChildModel		IModel
	 * @return	void
	 */
	public function OnLoadChild(DBRecordSet $aRecordSet,ORM $aORM,IModel $aChildModel)
	{
		ASSERT::ASSERT_INSTANCE($aChildModel,'JCAT\DBAdjacensyCategory') ;
		
		$aChildModel->Loading(true) ;
		parent::OnLoadChild($aRecordSet,$aORM,$aChildModel) ;
		$aChildModel->Loading(false) ;
	}
	
	/**
	 * Description
	 *
	 * @access	public
	 * @return	IIterator
	 */
	public function CreateRootCategoryIter()
	{
		return $this->aVirtualRootCategory?
					$this->aVirtualRootCategory->CreateModelIterator() :
					new NullIterator() ;
	}
	
	/**
	 * Description
	 *
	 * @access	public
	 * @return	void
	 */
	public function BuildTree()
	{
		// 排序
		$this->aModelContainer->SortByName() ;
		
		// building
		// ----------------------------
		$aIterator = $this->CreateModelIterator() ;
		
		// create a virtual root category to collect categories
		$aNewORM = clone $this->GetORM() ;
		$this->aVirtualRootCategory = new DBAdjacensyCategory($aNewORM) ;
		
		// loop other categories
		for ( $aIterator->First(); !$aIterator->IsDone(); $aIterator->Next() )
		{
			$aCategory = $aIterator->Current() ;			
			$this->aVirtualRootCategory->PutInTree($aCategory) ;
		}
	}
	
	// 属性 ////////////////////////////////////////////////////
	
	/**
	 * Description
	 * 
	 * @access	private
	 * @var		DBAdjacensyCategory
	 */
	private $aVirtualRootCategory ;
}

?>